<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>LibCDS: /home/zsshen/Desktop/git-hub-code/C-Common-Data-Structures/include/container/queue.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">LibCDS
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('queue_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="headertitle">
<div class="title">queue.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="queue_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * @file queue.h The FIFO queue.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#ifndef _QUEUE_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define _QUEUE_H_</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;../util.h&quot;</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">/** QueueData is the data type for the container private information. */</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"><a class="line" href="queue_8h.html#a0748e958e26915341229e2c55cf98d14">   11</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_QueueData <a class="code" href="queue_8h.html#a0748e958e26915341229e2c55cf98d14">QueueData</a>;</div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">/** The implementation for queue. */</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="structQueue.html">   14</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>_Queue {<span class="comment"></span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">    /** The container private information */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structQueue.html#a1422a23444ea333bb1ebd64c88228029">   16</a></span>&#160;    <a class="code" href="queue_8h.html#a0748e958e26915341229e2c55cf98d14">QueueData</a> *<a class="code" href="structQueue.html#a1422a23444ea333bb1ebd64c88228029">pData</a>;</div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment">    /** Insert an item to the tail of the queue.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment">        @see QueuePush */</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structQueue.html#a3059f2c6345c67f67350e9f1449ed9dc">   20</a></span>&#160;    int32_t (*push) (<span class="keyword">struct </span>_Queue*, Item);</div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment">    /** Retrieve item from the head of the queue.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment">        @see QueueFront */</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structQueue.html#a59bb3227707ee858e629bf7536956fdb">   24</a></span>&#160;    int32_t (*front) (<span class="keyword">struct </span>_Queue*, Item*);</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">    /** Retrieve item from the tail of the queue.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">        @see QueueBack */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="structQueue.html#a535301dfb76b3b5aaca8d196090725c2">   28</a></span>&#160;    int32_t (*back) (<span class="keyword">struct </span>_Queue*, Item*);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment">    /** Delete an item from the head of the queue.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment">        @see QueuePop */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structQueue.html#a0df3215a0fafc2c56090787cf8212b41">   32</a></span>&#160;    int32_t (*pop) (<span class="keyword">struct </span>_Queue*);</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">    /** Return the number of stored items.</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">        @see QueueSize */</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structQueue.html#a2ef387d7de5650223637407d8f808471">   36</a></span>&#160;    int32_t (*size) (<span class="keyword">struct </span>_Queue*);</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment">    /** Set the custom item resource clean method.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">        @see QueueSetDestroy */</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="structQueue.html#a448521d11b51393a9f8fd8b5893f6b6a">   40</a></span>&#160;    int32_t (*set_destroy) (<span class="keyword">struct </span>_Queue*, void (*) (Item));</div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;} <a class="code" href="structQueue.html">Queue</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">/*===========================================================================*</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment"> *             Definition for the exported member operations                 *</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment"> *===========================================================================*/</span><span class="comment"></span></div>
<div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"> * @brief The constructor for Queue.</span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be constructed queue</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for queue construction</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;int32_t <a class="code" href="queue_8h.html#a65525752690b76b5f2bf00916b6bce7f">QueueInit</a>(<a class="code" href="structQueue.html">Queue</a> **ppObj);</div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"> * @brief The destructor for Queue.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment"> * If the custom resource clean method is set, it also runs the clean method</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment"> * for all the items.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;<span class="comment"> * @param ppObj         The double pointer to the to be destructed queue</span></div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="keywordtype">void</span> <a class="code" href="queue_8h.html#a22c25dc6ccd87ba9a19d13d728150a1f">QueueDeinit</a>(<a class="code" href="structQueue.html">Queue</a> **ppObj);</div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;<span class="comment"> * @brief Insert an item to the tail of the queue.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;<span class="comment"> * This function inserts an item to the tail of the queue with the corresponding</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"> * queue size extension.</span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment"> * @param item          The designated item</span></div>
<div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="comment"> * @retval ERR_NOMEM    Insufficient memory for queue extension</span></div>
<div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;int32_t <a class="code" href="queue_8h.html#ae50136d9a5f9699e3ad3910658125513">QueuePush</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>, Item item);</div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment"> * @brief Delete item from top of the queue.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;<span class="comment"> * This function deletes item from top of the queue. If the custom resource clean</span></div>
<div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;<span class="comment"> * method is set, it also runs the clean method for the deleted item.</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty queue</span></div>
<div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;int32_t <a class="code" href="queue_8h.html#a559d13d3e2eaa0d548e737b0aab6b3bb">QueuePop</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"> * @brief Retrieve item from the head of the queue.</span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment"> * This function retrieves item from the head of the queue. If the queue is not</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment"> * empty, the item is returned by the second parameter. Otherwise, the error</span></div>
<div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;<span class="comment"> * code is returned and the second parameter is updated with NULL.</span></div>
<div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty queue</span></div>
<div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned item</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;int32_t <a class="code" href="queue_8h.html#a6531988b67c4bd3ed67a7853114f0ba0">QueueFront</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>, Item *pItem);</div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;<span class="comment"> * @brief Retrieve item from the tail of the queue.</span></div>
<div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;<span class="comment"> * This function retrieves item from the tail of the queue. If the queue is not</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"> * empty, the item is returned by the second parameter. Otherwise, the error</span></div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;<span class="comment"> * code is returned and the second parameter is updated with NULL.</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;<span class="comment"> * @param pItem         The pointer to the returned item</span></div>
<div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"> * @retval ERR_IDX      Empty queue</span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;<span class="comment"> * @retval ERR_GET      Invalid parameter to store returned item</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;int32_t <a class="code" href="queue_8h.html#ad1930f0e825f7161e58642dd744571cd">QueueBack</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>, Item *pItem);</div>
<div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;</div>
<div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;<span class="comment"> * @brief Return the number of stored items.</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment"> * @return              The number of items</span></div>
<div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00138"></a><span class="lineno">  138</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00139"></a><span class="lineno">  139</span>&#160;int32_t <a class="code" href="queue_8h.html#a727b057ec177882fe7649e62c128d7b0">QueueSize</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>);</div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment"> * @brief Set the custom item resource clean method.</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00144"></a><span class="lineno">  144</span>&#160;<span class="comment"> * @param self          The pointer to Queue structure</span></div>
<div class="line"><a name="l00145"></a><span class="lineno">  145</span>&#160;<span class="comment"> * @param pFunc         The function pointer to the custom method</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;<span class="comment"> * @retval SUCC</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment"> * @retval ERR_NOINIT   Uninitialized container</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno">  150</span>&#160;int32_t <a class="code" href="queue_8h.html#aba15201b5633661f312eff3521117108">QueueSetDestroy</a>(<a class="code" href="structQueue.html">Queue</a> *<span class="keyword">self</span>, <span class="keywordtype">void</span> (*pFunc) (Item));</div>
<div class="line"><a name="l00151"></a><span class="lineno">  151</span>&#160;</div>
<div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="ttc" id="queue_8h_html_a727b057ec177882fe7649e62c128d7b0"><div class="ttname"><a href="queue_8h.html#a727b057ec177882fe7649e62c128d7b0">QueueSize</a></div><div class="ttdeci">int32_t QueueSize(Queue *self)</div><div class="ttdoc">Return the number of stored items. </div></div>
<div class="ttc" id="queue_8h_html_a6531988b67c4bd3ed67a7853114f0ba0"><div class="ttname"><a href="queue_8h.html#a6531988b67c4bd3ed67a7853114f0ba0">QueueFront</a></div><div class="ttdeci">int32_t QueueFront(Queue *self, Item *pItem)</div><div class="ttdoc">Retrieve item from the head of the queue. </div></div>
<div class="ttc" id="structQueue_html_a1422a23444ea333bb1ebd64c88228029"><div class="ttname"><a href="structQueue.html#a1422a23444ea333bb1ebd64c88228029">Queue::pData</a></div><div class="ttdeci">QueueData * pData</div><div class="ttdoc">The container private information. </div><div class="ttdef"><b>Definition:</b> <a href="queue_8h_source.html#l00016">queue.h:16</a></div></div>
<div class="ttc" id="queue_8h_html_a65525752690b76b5f2bf00916b6bce7f"><div class="ttname"><a href="queue_8h.html#a65525752690b76b5f2bf00916b6bce7f">QueueInit</a></div><div class="ttdeci">int32_t QueueInit(Queue **ppObj)</div><div class="ttdoc">The constructor for Queue. </div></div>
<div class="ttc" id="queue_8h_html_a559d13d3e2eaa0d548e737b0aab6b3bb"><div class="ttname"><a href="queue_8h.html#a559d13d3e2eaa0d548e737b0aab6b3bb">QueuePop</a></div><div class="ttdeci">int32_t QueuePop(Queue *self)</div><div class="ttdoc">Delete item from top of the queue. </div></div>
<div class="ttc" id="structQueue_html"><div class="ttname"><a href="structQueue.html">Queue</a></div><div class="ttdoc">The implementation for queue. </div><div class="ttdef"><b>Definition:</b> <a href="queue_8h_source.html#l00014">queue.h:14</a></div></div>
<div class="ttc" id="queue_8h_html_a0748e958e26915341229e2c55cf98d14"><div class="ttname"><a href="queue_8h.html#a0748e958e26915341229e2c55cf98d14">QueueData</a></div><div class="ttdeci">struct _QueueData QueueData</div><div class="ttdoc">QueueData is the data type for the container private information. </div><div class="ttdef"><b>Definition:</b> <a href="queue_8h_source.html#l00011">queue.h:11</a></div></div>
<div class="ttc" id="queue_8h_html_aba15201b5633661f312eff3521117108"><div class="ttname"><a href="queue_8h.html#aba15201b5633661f312eff3521117108">QueueSetDestroy</a></div><div class="ttdeci">int32_t QueueSetDestroy(Queue *self, void(*pFunc)(Item))</div><div class="ttdoc">Set the custom item resource clean method. </div></div>
<div class="ttc" id="queue_8h_html_a22c25dc6ccd87ba9a19d13d728150a1f"><div class="ttname"><a href="queue_8h.html#a22c25dc6ccd87ba9a19d13d728150a1f">QueueDeinit</a></div><div class="ttdeci">void QueueDeinit(Queue **ppObj)</div><div class="ttdoc">The destructor for Queue. </div></div>
<div class="ttc" id="queue_8h_html_ae50136d9a5f9699e3ad3910658125513"><div class="ttname"><a href="queue_8h.html#ae50136d9a5f9699e3ad3910658125513">QueuePush</a></div><div class="ttdeci">int32_t QueuePush(Queue *self, Item item)</div><div class="ttdoc">Insert an item to the tail of the queue. </div></div>
<div class="ttc" id="queue_8h_html_ad1930f0e825f7161e58642dd744571cd"><div class="ttname"><a href="queue_8h.html#ad1930f0e825f7161e58642dd744571cd">QueueBack</a></div><div class="ttdeci">int32_t QueueBack(Queue *self, Item *pItem)</div><div class="ttdoc">Retrieve item from the tail of the queue. </div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_e0f5f6345e438c73b9ae78ec2940718c.html">container</a></li><li class="navelem"><a class="el" href="queue_8h.html">queue.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
